dundas.controls.AutoColorRule Class

A binding rule that maps a numeric range of data values into multiple color values. The rule can divide the overall input range into a number of classes using an automatic distribution function.
 

Inheritance Hierarchy

 
Class
   dundas.controls.BindingRule
      dundas.controls.ColorBindingRule
         dundas.controls.AutoColorRule
 

Constructors

 
  Name Description
init Initializes a new instance of the AutoColorRule class. Inherited from dundas.controls.BindingRule.
 
 

Properties

 
  Name Description
classes Gets the current set of data binding classes for this rule. Inherited from dundas.controls.BindingRule.
colorScaleFormat Gets or sets the format of the color scale labels. Inherited from dundas.controls.ColorBindingRule.
colorScaleSymbol Gets or sets the text displaced before or after the values in the color scale labels. Inherited from dundas.controls.ColorBindingRule.
colorScaleSymbolPlacement Gets or sets whether the label symbol is placed before or after the value. Inherited from dundas.controls.ColorBindingRule.
dataRange Gets or sets the range of data values this rule applies to.
distribution Gets or sets the type of distribution to use.
from Gets or sets the color value that corresponds to the beginning of the data range.
isDisplayedInColorScale Gets or sets a value indicating whether this color rule is displayed in a color scale in the legend when its classes are ranges of numeric values. Inherited from dundas.controls.ColorBindingRule.
isDisplayedInLegend Gets or sets a value indicating whether this rule is displayed in the legend. Inherited from dundas.controls.BindingRule.
legendCategory Gets or sets the category within which to group legend items displaying this binding rule's classes. Inherited from dundas.controls.BindingRule.
legendText Gets or sets text that includes placeholder keywords used to display the ranges of values generated by this rule.
middle Gets or sets an optional color value that corresponds to the middle of the data range.
middleValue Gets or sets an optional data value to be associated with the middle color.
numberOfClasses Gets or sets the requested number of classes to create with the distribution function. Required when dundas.controls.AutoColorRule.distribution is not CONTINUOUS.
to Gets or sets the color value that corresponds to the end of the data range.
 
 

Methods

 
  Name Description
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
setThreeColorDefaults Sets default settings using three colors.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
toString Returns a string representation of this object.